/*
 *	fe_memutils.h
 *		前端代码的内存管理支持
 *
 *	Copyright (c) 2003-2022, PostgreSQL Global Development Group
 *
 *	src/include/common/fe_memutils.h
 */
#ifndef FE_MEMUTILS_H
#define FE_MEMUTILS_H

/*
 * pg_malloc_extended 和 palloc_extended 的标志，故意与后端标志同名。
 */
#define MCXT_ALLOC_HUGE			0x01	/* 允许巨大的分配（> 1 GB），实际上不用于前端 */
#define MCXT_ALLOC_NO_OOM		0x02	/* 如果内存不足则不失败 */
#define MCXT_ALLOC_ZERO			0x04	/* 零分配内存 */

/*
 * “安全”的内存分配函数 --- 这些函数在失败时 exit(1)
 * （除了 pg_malloc_extended 和 MCXT_ALLOC_NO_OOM）
 */
extern char *pg_strdup(const char *in);
extern void *pg_malloc(size_t size);
extern void *pg_malloc0(size_t size);
extern void *pg_malloc_extended(size_t size, int flags);
extern void *pg_realloc(void *pointer, size_t size);
extern void pg_free(void *pointer);

/*
 * 更易于书写且类型安全性更高的变体
 */

/*
 * 为类型为“type”的一个对象分配空间
 */
#define pg_malloc_object(type) ((type *) pg_malloc(sizeof(type)))
#define pg_malloc0_object(type) ((type *) pg_malloc0(sizeof(type)))

/*
 * 为类型为“type”的“count”个对象分配空间
 */
#define pg_malloc_array(type, count) ((type *) pg_malloc(sizeof(type) * (count)))
#define pg_malloc0_array(type, count) ((type *) pg_malloc0(sizeof(type) * (count)))


/*
 * 将“pointer”所指向的分配大小更改为具有“count”个
 * 类型为“type”的对象的空间
 */
#define pg_realloc_array(pointer, type, count) ((type *) pg_realloc(pointer, sizeof(type) * (count)))

/* 等效函数，故意与后端函数同名 */
extern char *pstrdup(const char *in);
extern char *pnstrdup(const char *in, Size size);
extern void *palloc(Size size);
extern void *palloc0(Size size);
extern void *palloc_extended(Size size, int flags);
extern void *repalloc(void *pointer, Size size);
extern void pfree(void *pointer);

#define palloc_object(type) ((type *) palloc(sizeof(type)))
#define palloc0_object(type) ((type *) palloc0(sizeof(type)))
#define palloc_array(type, count) ((type *) palloc(sizeof(type) * (count)))
#define palloc0_array(type, count) ((type *) palloc0(sizeof(type) * (count)))
#define repalloc_array(pointer, type, count) ((type *) repalloc(pointer, sizeof(type) * (count)))

/* sprintf 到 palloc 的缓冲区 --- 这些在 psprintf.c 中 */
extern char *psprintf(const char *fmt,...) pg_attribute_printf(1, 2);
extern size_t pvsnprintf(char *buf, size_t len, const char *fmt, va_list args) pg_attribute_printf(3, 0);

#endif							/* FE_MEMUTILS_H */
